Inheritance diagram for StringElement:

Public Member Functions
String	getEncoding ()
	Get encoding. More...

	setEncoding (String encoding)
	Set encoding. More...

int	getBytesPerChar ()
	Get bytes per character. More...

STRING_LENGTH_TYPE	getLengthType ()
	Get string length type. More...

Public Member Functions inherited from Element
Element	Element (ELEMENT_TYPE type, String name, bool setDefaults)
	Constructor. More...

String	getName ()
	Get name. More...

	setName (String name)
	Set name. More...

String	getDescription ()
	Get description. More...

	setDescription (String name)
	Set description. More...

	setDisabled (BOOL disabled)
	Set disabled. More...

	addFixedValue (Value value)
	Add fixed value. More...

Structure	getEnclosingStructure ()
	Get enclosing structure. More...

String	getLength ()
	Get length. More...

LENGTH_UNIT	getLengthUnit ()
	Get length unit. More...

	setColorRgb (float red, float green, float blue)
	Set fill color (RGB). More...

	setLength (String length, LENGTH_UNIT lengthUnit)
	Set length. More...

ELEMENT_TYPE	getType ()
	Get type. More...

bool	mustMatch ()
	Get "must match" flag. More...

	setMustMatch (BOOL mustMatch)
	Set "must match" flag. More...

Value	getMinValue ()
	Get minimum value. More...

Value	getMaxValue ()
	Get maximum value. More...

Element	getParent ()
	Get parent. More...

Detailed Description

A string element object represents one string item in a structure.

Member Function Documentation

int getBytesPerChar ( )

Get bytes per character.

Get the number of bytes a character needs. This information is derived from the selected string encoding

String getEncoding ( )

Get encoding.

Get encoding of string element.

STRING_LENGTH_TYPE getLengthType ( )

Get string length type.

Get length type of string element. Valid types are:

setEncoding ( String encoding )

Set encoding.

Set string encoding of element.

Parameters

[in] encoding The new string encoding of the element

The documentation for this class was generated from the following file: